// Magic Software, Inc.
// http://www.magic-software.com
// Copyright (c) 2000, All Rights Reserved
//
// Source code from Magic Software is supplied under the terms of a license
// agreement and may not be copied or disclosed except in accordance with the
// terms of that agreement.  The various license agreements may be found at
// the Magic Software web site.  This file is subject to the license
//
// FREE SOURCE CODE
// http://www.magic-software.com/License/free.pdf

#ifndef MGCTCLASSMAP_H
#define MGCTCLASSMAP_H

#include "MgcMath.h"
#include "MgcRTLib.h"

// The class TKEY is intended to be class data and must have the following
// member functions:
//   TKEY::TKEY ()
//   TKEY& TKEY::operator= (const TKEY&)
//   bool TKEY::operator== (const TKEY&) const
//   bool TKEY::operator!= (const TKEY&) const
//   TKEY::operator unsigned int () const
// The implicit conversion to unsigned int is used to select a hash table
// index from the key.
//
// The class TVALUE must have the following member functions:
//   TVALUE::TVALUE ()
//   TVALUE& TVALUE::operator= (const TVALUE&)

template <class TKEY, class TVALUE>
class MgcTClassMap
{
public:
    // construction and destruction
    MgcTClassMap (unsigned int uiTableSize);
    ~MgcTClassMap ();

    // element access
    unsigned int GetQuantity () const;
    bool IsEmpty () const;
    bool SetAt (const TKEY& rtKey, const TVALUE& rtValue);
    bool GetAt (const TKEY& rtKey, TVALUE& rtValue) const;
    bool RemoveAt (const TKEY& rtKey);
    void RemoveAll ();

    // linear traversal of map
    bool GetFirst (TKEY& rtKey, TVALUE& rtValue);
    bool GetNext (TKEY& rtKey, TVALUE& rtValue);

protected:
    class HashItem
    {
    public:
        TKEY m_tKey;
        TVALUE m_tValue;
        HashItem* m_pkNext;
    };

    // key-to-index construction
    unsigned int HashFunction (const TKEY& rtKey) const;

    // hash table
    unsigned int m_uiTableSize;
    unsigned int m_uiQuantity;
    HashItem** m_apkTable;

    // iterator for traversal
    unsigned int m_uiIndex;
    HashItem* m_pkItem;
};

#include "MgcTClassMap.inl"

#endif

